From IQsimWiki
XIQS Get User List - User Management
| Description
|
getXIQSUserList ( [Long id_partition][, filter f] )
Get a list of xiqs users owned by this user's partition. In the case the current logged user is administrator, he gets the full list of all available users unless a 'PartitionID' parameter is specified.
Note: an optional parameter is available for admin to limit the list to a specified partition, otherwise a full list of all partition is returned.
|
| Parameters
|
|
[ Long id_partition ]
Partition Id
[ filter f ]
|
| Return Values
|
List List of user's information
Long id - User Id
String login - User's login name
String password - User's login password
Long id_partition - Partition Id
Integer timezone - User's timezone Id, see Timezone table
String lastname - User's last name
String firstname - User's first name
String email - User's email
String lang - User's language
Integer uiallowed - Flag which shows if User Interface is allowed for this user
Error Data structure ( Error Management )
Possible failure code returns
*ERR_SRV_INTERNAL (500) ERR_MSG_NO_DB
|
| Example
|
|
[REQUEST]
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<command tid="2cb4ac99-137c-4af7-aa15-6e19be958298" name="getXIQSUserList">
<simplefilter>
<start>0</start>
<limit>0</limit>
<DIR>ASC</DIR>
<SORT>
</SORT>
</simplefilter>
</command>
[ANSWER (OK)]
<?xml version="1.0" encoding="ISO-8859-1"?>
<event type="return" tid="2cb4ac99-137c-4af7-aa15-6e19be958298">
<meta-data>
<meta-value>
<name>start</name>
<pos>1</pos>
</meta-value>
<meta-value>
<name>count</name>
<pos>2</pos>
</meta-value>
<meta-value>
<name>total</name>
<pos>3</pos>
</meta-value>
<user-meta>
<meta-value>
<name>id</name>
<pos>1</pos>
</meta-value>
<meta-value>
<name>login</name>
<pos>2</pos>
</meta-value>
<meta-value>
<name>password</name>
<pos>3</pos>
</meta-value>
<meta-value>
<name>id_partition</name>
<pos>4</pos>
</meta-value>
<meta-value>
<name>timezone</name>
<pos>5</pos>
</meta-value>
<meta-value>
<name>lastname</name>
<pos>6</pos>
</meta-value>
<meta-value>
<name>firstname</name>
<pos>7</pos>
</meta-value>
<meta-value>
<name>email</name>
<pos>8</pos>
</meta-value>
<meta-value>
<name>lang</name>
<pos>9</pos>
</meta-value>
<meta-value>
<name>uiallowed</name>
<pos>10</pos>
</meta-value>
</user-meta>
</meta-data>
<param type="long">0</param>
<param type="long">1</param>
<param type="long">1</param>
<user>
<param type="long">2</param>
<param type="string">administrator</param>
<param type="string">iqsim</param>
<param type="long">1</param>
<param type="integer">82</param>
<param type="string">
</param>
<param type="string">
</param>
<param type="string">
</param>
<param type="string">
</param>
<param type="integer">1</param>
</user>
</event>
[ANSWER (Error)]
<?xml version="1.0" encoding="ISO-8859-1"?>
<event type="error">
<meta-data>
<meta-value>
<name>err_code</name>
<pos>1</pos>
</meta-value>
<meta-value>
<name>err_desc</name>
<pos>2</pos>
</meta-value>
</meta-data>
<param type="integer">500</param>
<param type="string"> err.db.connection.failed </param>
</event>
|
